home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 301-325 / disk_325 / keymacro / keymacro.doc < prev    next >
Text File  |  1992-05-06  |  9KB  |  207 lines
  1. ======================================================================
  2. =========================== KeyMacro v1.0 ============================
  3. ================== * A macro key handler utility * ===================
  4. ======================================================================
  5.  
  6.                              BACKGROUND:
  7.                              -----------
  8. Some  time  ago  I  played around with a keymap editor to customize my
  9. keymap  settings.  But there was a feature I missed:  there wasn't any
  10. hot-key  support  (just  like  PopCLI  or  DMouse).  I also discovered
  11. another  disadvantage:   to change the keymap settings you had to load
  12. the  keymap  editor, edit the map, save it to disk and then install it
  13. via  SetMap.   With  these  topics  in  mind I decided to write my own
  14. keyboard macro handler.
  15.  
  16.  
  17.                               FEATURES:
  18.                               ---------
  19. KeyMacro  provides  an  easy  way to manage keyboard macros (character
  20. sequences)  and  hot-key program execution.  You edit a script file in
  21. which  all  required key combinations are defined and call KeyMacro to
  22. update the macro list - that's all.  You can map up to eight functions
  23. to  each  key, including keys such as the cursor keys, the return key,
  24. etc.   The hot-key programs will use an AmigaDOS search path list when
  25. getting  executed.  Each macro key call gets processed asynchronously,
  26. i.e.   invoking  one  hot-key  command  after the other will start all
  27. commands, nothing will be skipped.
  28.  
  29.  
  30.                             INSTALLATION:
  31.                             -------------
  32. Place  KeyMacro-Handler in L:, KeyMacro in C:  or SYS:, mxm.library in
  33. LIBS:,   copy   your   KeyMacro.config  to  S:.   Type  "KeyMacro"  to
  34. install/update  macro  keys, "KeyMacro quit" to remove.  Note:  if the
  35. installation  fails  the  main  process  ("KeyMacro")  will wait for a
  36. handshake signal which may never arrive.  In this case pressing CTRL-C
  37. will  stop  the  main  process.   It will shut down and issue an error
  38. message.
  39.  
  40.  
  41.                                 USAGE:
  42.                                 ------
  43. KeyMacro is controlled via a script file.  Here is a sample:
  44.  
  45.     ; KeyMacro v1.0 configuration file.
  46.     ; The semicolon says that this is a comment:
  47.  
  48.     ; Some keyboard macros.
  49.  
  50.     key ctrl+esc = "EndCLI > NIL:\n"
  51.     key lalt+0 = "CD DF0:\n"
  52.     key lalt+1 = "CD DF1:\n"
  53.  
  54.     ; A hot-key command definition
  55.  
  56.     command lalt+v = "C:vt100 +i s:vt100.init" window "VT100"
  57.  
  58. Each  definition  must  be  "key"  or "command".  "Key" means that the
  59. following  definition  will be a sequence of characters to be inserted
  60. into  the input stream.  "Command" means that the following definition
  61. will be the name and the arguments of a program to be executed.
  62.     The  macro  type  is  followed  by  the  key combination to be
  63. pressed to execute the macro definition.  This combination consists of
  64. the keyboard qualifier and the key.  An unlimited number of qualifiers
  65. are allowed.  KeyMacro knows the following qualifiers:
  66.  
  67.     NONE ..........    No qualifier (note: a qualifier MUST be given!)    
  68.     CTRL ..........    The control key
  69.     NUMPAD ........    The numeric pad
  70.     LSHIFT ........    The left shift key
  71.     RSHIFT ........    The right shift key
  72.     LALT ..........    The left alternate key
  73.     RALT ..........    The right alternate key
  74.     LAMIGA ........    The left Amiga key (Commodore key)
  75.     RAMIGA ........    The right Amiga key
  76.  
  77. A qualifier must be given or the macro parser will panic; if you don't
  78. need a qualifier simply enter NONE as the qualifier.
  79.     The  qualifier  is  followed  by  the  key to attach the macro
  80. expression  to.   This  can  be  any  key  on  the keyboard, including
  81. function keys, cursor keys, etc.  If there is no ASCII value available
  82. for the key, you can take a name from the following list:
  83.  
  84.     TAB ...........    The tabulator key
  85.     ESC ...........    The escape key
  86.     SPACE .........    The space key
  87.     RETURN ........    The return key
  88.     ENTER .........    The enter key (numeric pad)
  89.     DEL ...........    The delete key
  90.     BACKSPACE .....    The backspace key
  91.     HELP ..........    The help key
  92.  
  93.     LEFT ..........    The cursor-left key
  94.     RIGHT .........    The cursor-right key
  95.     UP ............    The cursor-up key
  96.     DOWN ..........    The cursor-down key
  97.  
  98.     F1 ............    The function key #1
  99.     F2 ............    The function key #2
  100.     F3 ............    The function key #3
  101.     F4 ............    The function key #4
  102.     F5 ............    The function key #5
  103.     F6 ............    The function key #6
  104.     F7 ............    The function key #7
  105.     F8 ............    The function key #8
  106.     F9 ............    The function key #9
  107.     F10 ...........    The function key #10
  108.  
  109. These  equivalents  can  be  used just like characters.  Note:  if you
  110. enter more than one single character as the command key only the first
  111. character will be taken (except for the key names listed above).
  112.     The key is followed by a '=' sign, this tells the macro parser
  113. to remember the following string as the macro string to be
  114. entered/executed. This string must be enclosed in quotes or the parser
  115. will take only the first word of it. Inside this string sequences of
  116. two characters can be used to generate key codes not supported by the
  117. ASCII keyboard. These sequences are:
  118.  
  119.     \u ............    Cursor-up key
  120.     \d ............    Cursor-down key
  121.     \l ............    Cursor-left key
  122.     \r ............    Cursor-right key
  123.  
  124.     \n ............    The return key
  125.  
  126.     \h ............    The help key
  127.     \b ............    The backspace key
  128.     \e ............    The delete key (sorry, \d was already used)
  129.     \f1 - \f10 ....    The function keys
  130.     \" ............    A quote
  131.     \\ ............    The escape symbol ('\')
  132.  
  133. A  hot-key  command  definition can be followed by a "window" keyword.
  134. This  keyword  identifies  the next string (enclosed in quotes) as the
  135. typical window title of the command to be loaded.  Before this command
  136. is  executed  each open window is checked for this title.  If a window
  137. title matches the name it is brought to the front, no new command will
  138. be loaded.
  139.  
  140.                                   *
  141.  
  142.            KeyMacro has the following command-line options:
  143.  
  144. STARTUP .......    Followed by the name of the file to be used as
  145.         configuration file will keep KeyMacro from looking
  146.         for S:KeyMacro.config as the standard configuration
  147.         file.
  148.  
  149. QUIT ..........    Removes KeyMacro from memory.
  150.  
  151. INFO ..........    Gives a brief information on the program.
  152.  
  153.                           LAST MINUTE NOTE:
  154.                           -----------------
  155. Some  problems  showed  up  when  using  KeyMacro 1.0 on an A1000 with
  156. Kickstart  1.3,  so  there  is  no  guarantee that it will work on all
  157. Amigas.   I  am  still  trying to trace the problem back, but any help
  158. from  YOU  will  be  most appreciated.  That's why the original source
  159. code is distributed along with the executable files.  If you track the
  160. error,  please  tell  me  ASAP.   Note  that  there  is no source code
  161. available  for the mxm.library yet, I am of the opinion that it should
  162. be  released when it's complete.  The library itself is still open for
  163. enhancements  &  additions,  if you've got some useful subroutines you
  164. would like to have integrated into a shared library, mail them to me!
  165.  
  166.                                CREDITS:
  167.                                --------
  168. Credits  go  to ARP Programmers for the most recent version of ARP and
  169. to Matt Dillon for DMouse.
  170.     A  special mention must also go to Bill Hawes, author of ARexx
  171. and  to  the  authors of CygnusEd Professional 2 (Bruce Dawson & Colin
  172. Fox) whose programs both controlled the compiler runs.
  173.  
  174.  
  175.                    COPY FEE, AUTHORS REQUEST, ETC.:
  176.                    --------------------------------
  177. This  is the first time I release a program as shareware.  Consider it
  178. as  a  "test balloon" for coming projects.  A small contribution of at
  179. least $5 or at least DM 10,- will insure your registration, giving you
  180. the  opportunity  to  receive updates, new programs from MXM and more.
  181. Think  about  it, if you like this program and use it often this small
  182. amount of money will support the author and encourage him to start new
  183. projects.
  184.  
  185.        Send comments, bug reports, ideas and contributions to:
  186.  
  187.                       Olaf 'Olsen' Barthel, MXM
  188.                           Brabeckstrasse 35
  189.                           D-3000 Hannover 71
  190.  
  191.                      Federal Republic of Germany
  192.  
  193. Permission  hereby  granted  to  re-distribute  KeyMacro  v1.0  in its
  194. entirety for non profit usage.
  195.  
  196.  
  197.              REVISION HISTORY (most recent change first):
  198.              --------------------------------------------
  199. V1.0    First  public  release;  seems  that  it  works (what did I do
  200.     wrong?).
  201.  
  202.                                   *
  203.  
  204.              Do only its possibilities make it an Amiga?
  205.  
  206.                         WHERE IS THE MAGIC ???
  207.